<!doctype html>
<html lang="en">
<head>
    <title>API for class rootDoc (phpAPI: PHP Documentation Creator version 6.0)</title>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <meta name="generator" content="phpAPI 6.0 (https://github.com/Greenray/phpAPI/)">
    <link rel="stylesheet" type="text/css" href="../style.css">
    <link rel="start" href="../index.html">
</head>
    <body id="rootDoc" onload="parent.document.title=document.title;">
    <div class="header">
    <span style="float:right">phpAPI v6.0</span>
            <ul>
                    <li><a href="../overview-summary.html">Overview</a></li>
                    <li><a href="../phpapi/package-summary.html">Namespace</a></li>
                    <li class="active">Class</li>
                    <li><a href="../phpapi/package-tree.html">phpapi\Tree</a></li>
                    <li><a href="../deprecated.html">Deprecated</a></li>
                    <li><a href="../todo.html">Todo</a></li>
                    <li><a href="../index-all.html">Index</a></li>
                </ul>
    </div>
<hr />
<div class="small_links">Frames: <a href="../index.html" target="_top"> On</a> | <a href="" target="_top"> Off</a></div>
<hr />
    <div class="small_links">
        <a href="#details_fields">Fields</a> | <a href="#details_methods">Methods</a> | <a href="#details_constructor">Constructor</a>
    </div>
    <hr />
<div class="package">Namespace phpapi</div>
<h1>Class rootDoc</h1>
<div id="list">
    <ul>
        <li><a href="../phpapi/doc.html">doc</a><ul><li><strong>rootDoc</strong></li></ul></li>    </ul>
</div>
<hr />
<p class="arguments">public  class <strong>rootDoc</strong> extends <a href="../phpapi/doc.html">doc</a></p>
<div class="comment" id="overview_description">Нolds the information from one run of phpapi.<br /> Particularly the packages, classes and options specified by the user.<br /> It is  the root of the parsed tokens and is passed to the doclet to be formatted into output.</div>
<div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Program</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">phpapi: PHP Documentation Creator</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Version</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">6.0</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Author</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">Victor Nabatov greenray.spb@gmail.com</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Copyright</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">(c) 2015-2016 Victor Nabatov</td>
                    </tr>
            <tr>
            <td class="hid left w_100">License</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">Creative Commons Attribution-ShareAlike 4.0 International</td>
                    </tr>
            <tr>
            <td class="hid left w_100">File</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">/system/classes/rootDoc.php</td>
                    </tr>
        </table>
</div>
            <table class="inherit">
            <tr><th>Fields inherited from phpapi \ doc</th></tr>
            <tr>
                <td>
                                    <span><a href="../phpapi/doc.html#$data"><span class="green">$data, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#$desc"><span class="green">$desc, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#$docComment"><span class="green">$docComment, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#$inBody"><span class="green">$inBody, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#$name"><span class="green">$name, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#$overview"><span class="green">$overview, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#$root"><span class="green">$root, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#$tags"><span class="green">$tags</span></a>&nbsp;</span>
                                </td>
            </tr>
        </table>
                <table class="inherit">
            <tr><th>Methods inherited from phpapi \ doc</th></tr>
            <tr>
                <td>
                                    <span><a href="../phpapi/doc.html#construct">construct, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#isClass">isClass, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#isConstructor">isConstructor, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#isException">isException, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#isField">isField, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#isFunction">isFunction, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#isGlobal">isGlobal, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#isInterface">isInterface, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#isMethod">isMethod, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#isOrdinaryClass">isOrdinaryClass, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#isTrait">isTrait, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#mergeData">mergeData, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#set">set, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#setByRef">setByRef</a>&nbsp;</span>
                                </td>
            </tr>
        </table>
        <h2 id="details_fields">Fields</h2>
            <div class="location">system/classes/rootDoc.php at line 19</div>
        <pre class="arguments" id="packages">public  <a href="../phpapi/packagedoc.html">packageDoc</a> <strong><span class="green">$packages</span></strong> = NULL;</pre>
        <div class="details">Parsed packages</div>
        <hr />
            <div class="location">system/classes/rootDoc.php at line 22</div>
        <pre class="arguments" id="phpapi">public  <a href="../phpapi/phpapi.html">phpapi</a> <strong><span class="green">$phpapi</span></strong> = NULL;</pre>
        <div class="details">Reference to the phpapi application object</div>
        <hr />
        <h2 id="details_constructor">Constructor</h2>
    <div class="location">system/classes/rootDoc.php at line 31</div>
    <code class="arguments" id="construct">public  void <strong>construct</strong>(<a href="../phpapi/phpapi.html">phpapi</a> <span class="blue">&$phpapi</span>)</code>
    <div class="details">
            <span class="bold">require_once</span> MARKDOWN.<span class="red">'markdownInterface.php'</span>;<br/><br/><span class="bold">require_once</span> MARKDOWN.<span class="red">'markdown.php'</span>;<br/><br/><span class="bold">require_once</span> MARKDOWN.<span class="red">'markdownExtra.php'</span>;<br/><br/>            <p class="description">Constructor.<br /> Sets Reference to application object and parses the main overview file.<br /> Overview file is a markdown file, so it will be passed and represented at the main page of the documentation.</p>
        <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac"><a href="../phpapi/phpapi.html">phpapi</a></td>
                            <td class="hid blue w_100">&$phpapi</td>
                <td class="hid">Reference to the application object</td>
                    </tr>
        </table>
</div>
    </div>
    <h2 id="details_methods">Methods</h2>
            <div class="location">system/classes/rootDoc.php at line 65</div>
        <code class="arguments" id="classNamed">public  classDoc|NULL <strong>classNamed</strong> (<span class="lilac">string</span> <span class="blue">$name</span>)</code>
        <div class="details">
                    <p class="description">Returns a reference to a classDoc for the specified class/interface name.</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$name</td>
                <td class="hid">Class name</td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
            <div class="location">system/classes/rootDoc.php at line 91</div>
        <code class="arguments" id="classes">public  array <strong>classes</strong> ()</code>
        <div class="details">
                    <p class="description">Returns a reference to the classes and interfaces to be documented.</p>
                    </div>
        <hr />
            <div class="location">system/classes/rootDoc.php at line 110</div>
        <code class="arguments" id="functions">public  array <strong>functions</strong> ()</code>
        <div class="details">
                    <p class="description">Returns a reference to the functions to be documented.</p>
                    </div>
        <hr />
            <div class="location">system/classes/rootDoc.php at line 128</div>
        <code class="arguments" id="globals">public  array <strong>globals</strong> ()</code>
        <div class="details">
                    <p class="description">Returns a reference to the globals to be documented.</p>
                    </div>
        <hr />
            <div class="location">system/classes/rootDoc.php at line 152</div>
        <code class="arguments" id="packageNamed">public  packageDoc|NULL <strong>packageNamed</strong> (<span class="lilac">string</span> <span class="blue">$name</span>, <span class="lilac">boolean</span> <span class="blue">$create</span>, <span class="lilac">string</span> <span class="blue">$overview</span>)</code>
        <div class="details">
                    <p class="description">Returns a reference to a packageDoc for the specified package name.<br /> If a package of the requested name does not exist, this method will create the<br /> package object, add it to the root and return it.</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$name</td>
                <td class="hid">Package name</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">boolean</td>
                            <td class="hid blue w_100">$create</td>
                <td class="hid">Create package if it does not exist (default = FALSE)</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$overview</td>
                <td class="hid">Package description (default = <span class="red">""</span>)</td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
        <div class="header">
    <span style="float:right">phpAPI v6.0</span>
            <ul>
                    <li><a href="../overview-summary.html">Overview</a></li>
                    <li><a href="../phpapi/package-summary.html">Namespace</a></li>
                    <li class="active">Class</li>
                    <li><a href="../phpapi/package-tree.html">phpapi\Tree</a></li>
                    <li><a href="../deprecated.html">Deprecated</a></li>
                    <li><a href="../todo.html">Todo</a></li>
                    <li><a href="../index-all.html">Index</a></li>
                </ul>
    </div>
<hr />
<div class="small_links">Frames: <a href="../index.html" target="_top"> On</a> | <a href="" target="_top"> Off</a></div>
<hr />
    <div class="small_links">
        <a href="#details_fields">Fields</a> | <a href="#details_methods">Methods</a> | <a href="#details_constructor">Constructor</a>
    </div>
    </body>
</html>
